home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / Name.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  7.0 KB  |  263 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/Name.man,v 1.6 91/12/06 10:39:24 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tk_Name tk
  189. .BS
  190. .SH NAME
  191. Tk_Name, Tk_PathName, Tk_NameToWindow \- convert between names and window tokens
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tk.h>\fR
  195. .sp
  196. Tk_Uid
  197. \fBTk_Name\fR(\fItkwin\fR)
  198. .sp
  199. char *
  200. \fBTk_PathName\fR(\fItkwin\fR)
  201. .sp
  202. Tk_Window
  203. \fBTk_NameToWindow\fR(\fIinterp, pathName, tkwin\fR)
  204. .SH ARGUMENTS
  205. .AS Tcl_Interp *pathName
  206. .AP Tk_Window tkwin in
  207. Token for window.
  208. .AP Tcl_Interp *interp out
  209. Interpreter to use for error reporting.
  210. .AP char *pathName in
  211. Character string containing path name of window.
  212. .BE
  213.  
  214. .SH DESCRIPTION
  215. .PP
  216. Each window managed by Tk has two names, a short name that identifies
  217. a window among children of the same parent, and a path name that
  218. identifies the window uniquely among all the windows belonging to the
  219. same main window.  The path name is used more often in Tk than the
  220. short name;  many commands, like \fBbind\fR, expect path names as
  221. arguments.
  222. .PP
  223. The \fBTk_Name\fR macro returns a window's
  224. short name, which is the same as the \fIname\fR argument
  225. passed to \fBTk_CreateMainWindow\fR
  226. or \fBTk_CreateTopLevelWindow\fR or \fBTk_CreateChildWindow\fR when
  227. the window was created.  The value is returned
  228. as a Tk_Uid, which may be used just like a string pointer but also has
  229. the properties of a unique identfier (see the manual entry for
  230. \fBTk_GetUid\fR for details).
  231. .PP
  232. The \fBTk_PathName\fR macro returns a
  233. hierarchical name for \fItkwin\fR.
  234. Path names have a structure similar to file names in Unix but with
  235. dots between elements instead of slashes:  the main window for
  236. an application (one created by calling \fBTk_CreateMainWindow\fR
  237. or by calling \fBTk_CreateTopLevelWindow\fR with a NULL \fIparent\fR
  238. argument) has the path name ``.'';  its children have names like
  239. ``.a'' and ``.b''; their children have names like ``.a.aa'' and
  240. ``.b.bb''; and so on.  A window is considered to be be a child of
  241. another window for naming purposes if the second window was named
  242. as the first window's \fIparent\fR when the first window was created.
  243. This is not always the same as the X window hierarchy.  For
  244. example, a pop-up
  245. is created as a child of the root window, but its logical parent will
  246. usually be a window within the application.
  247. .PP
  248. The procedure \fBTk_NameToWindow\fR returns the token for a window
  249. given its path name (the \fIpathName\fR argument) and another window
  250. belonging to the same main window (\fItkwin\fR).  It normally
  251. returns a token for the named window, but if no such window exists
  252. \fBTk_NameToWindow\fR leaves an error message in \fIinterp->result\fR
  253. and returns NULL.  The \fItkwin\fR argument to \fBTk_NameToWindow\fR
  254. is needed because path names are only unique within a single
  255. application hierarchy.  If, for example, a single process has opened
  256. two main windows, each will have a separate naming hierarchy and the
  257. same path name might appear in each of the hierarchies.  Normally
  258. \fItkwin\fR is the main window of the desired hierarchy, but this
  259. need not be the case:  any window in the desired hierarchy may be used.
  260.  
  261. .SH KEYWORDS
  262. name, path name, token, window
  263.